<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../print.css" type="text/css" media="print">
<meta content="MDataGrid,com.iwobanas.controls.MDataGrid,copyDataProvider,originalCollection,found,searchExpression,searchString,find,findNext,findPrevious,invalidateColumnFilters" name="keywords">
<title>com.iwobanas.controls.MDataGrid</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'MDataGrid - ReusableFx components documentation';
				var baseRef = '../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">ReusableFx components documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../index-list.html')" href="../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../index.html?com/iwobanas/controls/MDataGrid.html&amp;com/iwobanas/controls/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;MDataGrid</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a>&nbsp;| <a href="#eventSummary">Events</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class MDataGrid"); titleBar_setSubNav(false,true,false,false,true,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">com.iwobanas.controls</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class MDataGrid</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">MDataGrid <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../images/inherit-arrow.gif"> mx.controls.DataGrid</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Implements</td><td><a href="../core/ISearchable.html">ISearchable</a></td>
</tr>
</table>
<p></p>
  This class extends standard mx.controls.DataGrid by adding following features:
  <ul>
  <li>Searching across all columns with option to find next / previous item</li>
  <li>Filtering data using column header drop downs</li>
  </ul>
  <p></p>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#copyDataProvider">copyDataProvider</a> : Boolean = true<div class="summaryTableDescription">
   Flag indicating if data provider should be copied.</div>
</td><td class="summaryTableOwnerCol">MDataGrid</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#found">found</a> : Boolean<div class="summaryTableDescription">[read-only]
   Flag indicating if last search ended successfully <code>true</code> or not <code>false</code>.</div>
</td><td class="summaryTableOwnerCol">MDataGrid</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#originalCollection">originalCollection</a> : ICollectionView<div class="summaryTableDescription">
   If <code>copyDataProvider</code> is set this variable will store 
   original data provider converted to ICollectionView if needed while
   <code>dataProvider</code> will store a copy of data provider.</div>
</td><td class="summaryTableOwnerCol">MDataGrid</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#searchExpression">searchExpression</a> : RegExp<div class="summaryTableDescription">[read-only]  
   String wildcard converted to the regular expression (RegExp).</div>
</td><td class="summaryTableOwnerCol">MDataGrid</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#searchString">searchString</a> : String<div class="summaryTableDescription">[read-only]
   String wildcard used in last search.</div>
</td><td class="summaryTableOwnerCol">MDataGrid</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#find()">find</a>(wildcard:String, caseInsensitive:Boolean = true):Boolean</div>
<div class="summaryTableDescription">
   Find item matching given wildcard and assign first match to selectedItem.</div>
</td><td class="summaryTableOwnerCol">MDataGrid</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#findNext()">findNext</a>():Boolean</div>
<div class="summaryTableDescription">
   Find next match using parameters specified in last call to <code>found()</code> function.</div>
</td><td class="summaryTableOwnerCol">MDataGrid</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#findPrevious()">findPrevious</a>():Boolean</div>
<div class="summaryTableDescription">
   Find previous match using parameters specified in last call to <code>found()</code> function.</div>
</td><td class="summaryTableOwnerCol">MDataGrid</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#invalidateColumnFilters()">invalidateColumnFilters</a>():void</div>
<div class="summaryTableDescription">
   Mark datagrid so that data provider will be refreshed
   (new filters values will take effect) on next call commitProperties().</div>
</td><td class="summaryTableOwnerCol">MDataGrid</td>
</tr>
</table>
</div>
<a name="eventSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Events</div>
<table id="summaryTableEvent" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Event</th><th>Summary</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#event:originalCollectionChange">originalCollectionChange</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
  Dispatched when the <code>originalCollection</code> property changes.</td><td class="summaryTableOwnerCol">MDataGrid</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="copyDataProvider"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">copyDataProvider</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>public var copyDataProvider:Boolean = true</code><p>
   Flag indicating if data provider should be copied.
   
   If <code>true</code> shallow copy of data provider is created
   and filters applied to data provider doesn't affect data provider.
   
   If <code>false</code> filters are applied to original data provider.
   
   NOTE: Changing this value when <code>dataProvider</code> is set 
   will take effect after next call to <code>dataProvider</code> setter.
   </p></div>
<a name="found"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">found</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>found:Boolean</code>&nbsp;&nbsp;[read-only]<p>
   Flag indicating if last search ended successfully <code>true</code> or not <code>false</code>.
   </p><p>This property can be used as the source for data binding.</p>
<span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get found():Boolean</code>
<br>
</div>
<a name="originalCollection"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">originalCollection</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var originalCollection:ICollectionView</code><p>
   If <code>copyDataProvider</code> is set this variable will store 
   original data provider converted to ICollectionView if needed while
   <code>dataProvider</code> will store a copy of data provider.
   
   If <code>copyDataProvider</code> is <code>false</code> this will equal 
   to <code>dataProvider</code>.
   </p><p>This property can be used as the source for data binding.</p>
</div>
<a name="searchExpression"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">searchExpression</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>searchExpression:RegExp</code>&nbsp;&nbsp;[read-only]<p>  
   String wildcard converted to the regular expression (RegExp).
   </p><p>This property can be used as the source for data binding.</p>
<span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get searchExpression():RegExp</code>
<br>
</div>
<a name="searchString"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">searchString</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>searchString:String</code>&nbsp;&nbsp;[read-only]<p>
   String wildcard used in last search.
   </p><p>This should equal to the string passed to the <code>find()</code> function.</p>
   <p>This property can be used as the source for data binding.</p>
<span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get searchString():String</code>
<br>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="find()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">find</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function find(wildcard:String, caseInsensitive:Boolean = true):Boolean</code><p>
   Find item matching given wildcard and assign first match to selectedItem.
   
   </p><p>Unlike standard findSting() function this functions searches labels of all visible columns.
   It also supports wildcards containing <code>"?"</code> or <code>"</code> characters 
   interpreted as any character or any character sequence respectively.</p>
   
   <p>The search starts at <code>selectedIndex</code> location and if match is find stops immediately.
   If it reaches the end of the data provider it starts over from the beginning. 
   If you need to navigate between matches user <code>findNext() / findPrevious()</code> functions.</p>
   
   <span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">wildcard</span>:String</code> &mdash; text to search for
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">caseInsensitive</span>:Boolean</code> (default = <code>true</code>)<code></code> &mdash; flag indicating whether search should be case insensitive
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Boolean</code> &mdash; <code>true</code> if text was fond or <code>false</code> if not
   
   </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../core/ISearchable.html" target="">com.iwobanas.core.ISearchable</a>
</div>
</div>
<a name="findNext()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">findNext</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function findNext():Boolean</code><p>
   Find next match using parameters specified in last call to <code>found()</code> function.
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Boolean</code></td>
</tr>
</table>
</div>
<a name="findPrevious()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">findPrevious</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function findPrevious():Boolean</code><p>
   Find previous match using parameters specified in last call to <code>found()</code> function.
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Boolean</code></td>
</tr>
</table>
</div>
<a name="invalidateColumnFilters()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">invalidateColumnFilters</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function invalidateColumnFilters():void</code><p>
   Mark datagrid so that data provider will be refreshed
   (new filters values will take effect) on next call commitProperties().
   
   This function may eventually be called by <code>"filteChange"</code> 
   and <code>"filterValueChange"</code> event handlers but for now 
   it is directly called by ColumnFilterBase.
   </p></div>
<div class="detailSectionHeader">Event detail</div>
<a name="event:originalCollectionChange"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">originalCollectionChange</td><td class="detailHeaderType">event&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<span class="label">Event object type: </span><a href="dataGridClasses/MDataGridEvent.html"><code>com.iwobanas.controls.dataGridClasses.MDataGridEvent</code></a>
<br>
<p></p><p>
  Dispatched when the <code>originalCollection</code> property changes.
  
  </p></div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright">&copy; 2009 Iwo Banaś - http://www.iwobanas.com</center>
</div>
</body>
</html>
<!--© 2009 Iwo Banaś - http://www.iwobanas.com-->
